home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 26 / Cream of the Crop 26.iso / os2 / uudbz002.zip / Install.doc < prev    next >
Text File  |  1997-08-09  |  8KB  |  192 lines

  1. This is the installation documentation for the Mome Raths BBS package
  2. dbz for UUPC/Extended.  This package is not part of the UUPC
  3. distribution, but is based upon their work.  UUPC/Extended is
  4. copyrighted, trademarked software, and every effort has been made to not
  5. knowingly infringe upon either one.
  6.  
  7. However, the dbz.c and dbz.h that are in this distribution are original
  8. works.  It has been made public domain by myself, the author.
  9.  
  10. Please read the README file for a more thorough explanation of what dbz
  11. is, why it is public domain and what it is used for.
  12.  
  13.  
  14. Unpacking:
  15.  
  16. I suggest that you make a copy of your UUPC source files, if you wish to
  17. recompile it, and use the copy rather than the originals.  Unzip this
  18. file into your source directory (UUPC\SOURCE on most configurations). 
  19. Files will be put into the SOURCE\NEWS and SOURCE\LIB directories as
  20. well as into SOURCE itself.
  21.  
  22. If you do not wish to recompile, you may unzip into a temporary
  23. directory.
  24.  
  25. Once you unzip the package, these are the files you should have:
  26.  
  27. README -- explains the prerequisites, what dbz is, what it is used for,
  28. what NoCEM is, why dbz is but isn't public domain and why I wrote it.
  29.  
  30. Install.doc -- this file, tells you how to install and use dbz.  How it
  31. may differ from other dbz programs.  How to recompile it using emx.
  32.  
  33. Change.log -- A list of changes made to the package.
  34.  
  35. Makefile.dbz -- for using dmake to recompile dbz.
  36.  
  37. dbz.exe -- a compiled executable, ready-to-go
  38.  
  39. dbzMake.Cmd -- a REXX script that sets up the correct paths to compile
  40. dbz.
  41.  
  42. dbz_mksetup.cmd -- a supporting REXX script called by dbzMake.Cmd, if
  43. necessary.  If the path has already been setup, then this does not get 
  44. called.
  45.  
  46. patchme.cmd -- a rather brainless batch file that can be used to patch 
  47. the sources.
  48.  
  49. testDBZ.Cmd -- a batch file used to test dbz errorlevel returns.
  50.  
  51. lib/lib.diff -- diff file for library files.
  52.  
  53. news/news.diff -- diff file for news files.
  54.  
  55. news/dbz.c -- source file for dbz executable.
  56.  
  57. news/dbz.h -- header file for dbz.
  58.  
  59.  
  60. Installation:
  61.  
  62. The binary will come out at the root of the directory where you unzipped
  63. this package.  Move the binary into the \UUPC\OS2BIN directory.  If you
  64. wish to keep the documentation, move them into \UUCP\DOCS.  I suggest 
  65. renaming them to avoid potential naming conflicts.
  66.  
  67. If you have your spool directory in an odd place, check UUPC.RC to make
  68. sure that the spool directory is specified.  However, it is unlikely
  69. that anything would work if it were incorrect.
  70.  
  71. That's basically it.  Now, test to make sure it is working correctly.
  72.  
  73.  
  74. Testing the installation:
  75.  
  76. To test, open an OS/2 window, and type:
  77.     dbz
  78.  
  79. It will give you an error that you typed it without parameters.  Now, try:
  80.     dbz -x "<1234>"
  81.  
  82. Note the quotes!  Without the quotes, it will interpret the '<' and '>'
  83. characters as redirection symbols.
  84.  
  85. The above command should not have given you any output.  Now, try:
  86.     dbz -m "<1234>"
  87.  
  88. It should spit <1234> back out at you.
  89.  
  90. If you have the GNU file utilities installed, try:
  91.     head g:\uucp\news\history.pag {or, wherever you have news installed}
  92.  
  93. You should get some somewhat human-readable stuff on the screen.  Using
  94. the handy OS/2 Warp window functions, find one between the '<' and '>'
  95. characters on one line, then click and hold the left mouse button down
  96. on the '<' character, drag it to the '>' character, and then let go. 
  97. Now, you should have the section you want highlighted on the screen. 
  98. Next, click on the highlighted section with the right mouse button, and
  99. a popup menu appears.  Choose "copy" from the menu, and the highlighting
  100. goes away.  Now, type:
  101.     dbz -x "
  102.  
  103. Next, press and release the [Alt] key, then press the [P] key.  The text
  104. will be pasted into the line.  Lastly, press ["] to finish the quote, so
  105. that the line looks simiar to:
  106.     dbz -x "<A0000009.$cv@penguin.com>"
  107.  
  108. Now, press return.  You should get something like:
  109.     <A0000009.$cv@penguin.com> 869834698 1388 news.software.readers:365
  110.  
  111. If you can see both, then compare to make sure that they are the same. 
  112. If not, something is definitely wrong.  Run expire and then genhist,
  113. then try again.  If the problem continues, do not use this program any
  114. further.  Do copy the entire screen to a file, send it and
  115. \UUPC\SPOOL\DBZ.LOG via email to MarchHare@momeraths.org.
  116.  
  117.  
  118. Differences:
  119.  
  120. I can only guess what the output of dbz on an actual C-News feed looks
  121. like.  However, from what I do know, there are some differences.  The 
  122. quotes being required around the key are the biggest and most important
  123. difference.  This version of dbz has been altered to output the key and 
  124. data, instead of just the data.  This was done to make it easier to work
  125. with NoCEM or NoCEM on spool.  It will also return an errorlevel of 1 if
  126. it could not add/find existing/find missing the database key input.
  127.  
  128. Not all functions are implemented, as I saw very little need.  You can
  129. append a record, extract (see) a record or extract (see) a missing
  130. record.  You cannot delete or modify a record.  Apparently, the UUPC
  131. routines do not modify records, either.  In any event NoCEM will only do
  132. those three functions, so they were the only ones implemented.
  133.  
  134. Another difference is that there is no provision for specifying the
  135. filename.  Since this is a narrowly targetted program, again, I did not
  136. see the need.  It also would have required a little more rewriting of
  137. various routines, and I wanted to change the actual UUPC source code as
  138. little as possible.  It could be done easily enough, however, by calling
  139. the functions directly, rather than going through open_history() and
  140. close_history().
  141.  
  142.  
  143. Recompiling:
  144.  
  145. The following instructions assume the emx development environment, and
  146. the prerequisites in the README.  If you are using a different compiler,
  147. follow the appropriate instructions for it.  The diff files are for
  148. emx/gcc.  They should NOT be required if you are using C-Set++ (UUPC is
  149. currently compiled with C-Set)!
  150.  
  151. In general, I tried to make the Makefile as general purpose as possible. 
  152. It should make all of the applicable UUPC libraries, but you will need 
  153. to add files that are specific to the executable. It should save anyone 
  154. some work, at lease.  To compile the entire UUPC package would still
  155. take some work.
  156.  
  157. Follow the installation instructions above, unzipping the package into a
  158. copy of the source.  You should delete the .EXE at the root of the
  159. directory, just to play it safe.
  160.  
  161. Next, you want to patch the source code for compiling under emx, using
  162. GNU's patch program.  The latest one is named "patchos2.exe".  I 
  163. apologize for the size of the diffs, but whenever I tried using -b, it
  164. would fail a lot.  So, I supplied the unified diffs without spacing 
  165. considerations.
  166.  
  167. I put a batch file in the package that can be used to run patchos2, if 
  168. you so desire.  I created it simply because I got tired of typing. 
  169. Otherwise, the following manual procedures will do the exact same thing.
  170.  
  171. Open an OS/2 command window, change into the LIB directory, then type:
  172.     patchos2 <lib.diff
  173.  
  174. Next, change into the NEWS directory, then type:
  175.     patchos2 <news.diff
  176.  
  177. Open an OS/2 command window and change to the directory you setup (if 
  178. you are not already there).  Don't attempt to run it from an editor's
  179. command environment, unless you can specify the REXX program to call
  180. (which would probably require changes to your menu, and probably not
  181. worth it).
  182.  
  183. Now, run:
  184.     dbzmake
  185.  
  186. *Everything* should make and be fine.  Unfortunately, it will build
  187. *everything* *every* time.  If you are adventurous, you can try to
  188. disable the RCS information and recompile.  Sorry, not my code, nothing
  189. I can really do about it except point you in the right direction or
  190. providing very large diff files (and chance breaking something).
  191.  
  192.